﻿/*
 * Copyright 2012 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Copyright (c) 2020 The Dotnetty-Span-Fork Project (cuteant@outlook.com)
 *
 *   https://github.com/cuteant/dotnetty-span-fork
 *
 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */

namespace DotNetty.Buffers
{
    using DotNetty.Common;

    public interface IByteBufferHolder : IReferenceCounted
    {
        /// <summary>
        ///     Return the data which is held by this {@link ByteBufHolder}.
        /// </summary>
        IByteBuffer Content { get; }

        /// <summary>
        ///     Create a deep copy of this {@link ByteBufHolder}.
        /// </summary>
        IByteBufferHolder Copy();

        /// <summary>
        ///     Duplicate the {@link ByteBufHolder}. Be aware that this will not automatically call {@link #retain()}.
        /// </summary>
        IByteBufferHolder Duplicate();

        /// <summary>
        ///     Duplicates this {@link ByteBufHolder}. This method returns a retained duplicate unlike {@link #duplicate()}.
        /// </summary>
        IByteBufferHolder RetainedDuplicate();

        /// <summary>
        ///    Returns a new {@link ByteBufHolder} which contains the specified {@code content}.
        /// </summary>
        IByteBufferHolder Replace(IByteBuffer content);
    }
}